Directory structure

root

gitignore

This description file specifies the excluded documents and folders from git.

README

This document contains a brief overview of the project working and how to use it, it’s oriented to the users of the package.

setup.py

This configuration file determines how the SoaM package is going to be installed and what commands it supports.

setup.cfg

This ini file defines default options for the setup.py commands.

documentation

Contains the technical documentation for the project, it’s oriented to the development team.

images

The diagrams and visualizations for the documentation.

classes

Explanation and diagrams of the classes and patterns in the project.

developers starting point

Steps description to setup the project for development. If you are new in SoaM this is your next document in your path to start developing.

project structure

This document :D

references

Papers, articles and videos to understand the theoretical background, libraries and technologies used in the project.

notebook

There are different proof of concepts, tests and usage examples.

soam

The root of the source code for the project.

db_migrations

This directory contains the migrations for the database that stores the data and runs with the DBSaver.

alembic.ini

Configures the alembic library to manage the migrations for the DBSaver.

resources

Files that will be used in the pipeline, like a template for an email report in a postprocess step.